Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: upgrade guide 0.5->0.8 #2132

Merged
merged 12 commits into from
Jan 14, 2022
Merged

fix: upgrade guide 0.5->0.8 #2132

merged 12 commits into from
Jan 14, 2022

Conversation

vinckr
Copy link
Member

@vinckr vinckr commented Jan 10, 2022

As suggested in
#2104
this

  • updates UPGRADE.md with some highlevel information on the breaking changes and links to the respective sections in the CHANGELOG for quick reference
  • adds a document upgrade.md in the /docs under "Debug & Help".
    I thought it makes more sense there, since it is not a very common occurance and the guide is not very extensive (yet).

I had trouble recreating a proper upgrade scenario to test everything using the quickstart or my own deployment, so I am hoping from some input.

Related issue(s)

Checklist

  • I have read the contributing guidelines.
  • I have referenced an issue containing the design document if my change
    introduces a new feature.
  • I am following the
    contributing code guidelines.
  • I have read the security policy.
  • I confirm that this pull request does not address a security
    vulnerability. If this pull request addresses a security. vulnerability, I
    confirm that I got green light (please contact
    [email protected]) from the maintainers to push
    the changes.
  • I have added tests that prove my fix is effective or that my feature
    works.
  • I have added or changed the documentation.

Further Comments

@codecov
Copy link

codecov bot commented Jan 10, 2022 •
edited
Loading

Codecov Report

Merging #2132 (0f4df7a) into master (b9fc641) will increase coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 0f4df7a differs from pull request most recent head 366e671. Consider uploading reports for the commit 366e671 to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2132      +/-   ##
==========================================
+ Coverage   75.21%   75.23%   +0.01%     
==========================================
  Files         293      293              
  Lines       15609    15600       -9     
==========================================
- Hits        11741    11736       -5     
+ Misses       3033     3031       -2     
+ Partials      835      833       -2
Impacted Files Coverage Δ
x/cookie.go 100.00% <0.00%> (ø)
continuity/manager_cookie.go 50.79% <0.00%> (+1.56%) ⬆️
persistence/sql/persister_courier.go 88.33% <0.00%> (+3.33%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b9fc641...366e671. Read the comment docs.

aeneasr
aeneasr reviewed Jan 10, 2022
View reviewed changes
UPGRADE.md Outdated Show resolved Hide resolved
aeneasr
aeneasr reviewed Jan 10, 2022
View reviewed changes
docs/docs/debug/upgrade.md Outdated Show resolved Hide resolved
docs/docs/debug/upgrade.md Outdated Show resolved Hide resolved
docs/sidebar.json Outdated Show resolved Hide resolved
docs/docs/debug/upgrade.md Outdated Show resolved Hide resolved
@vinckr
Copy link
Member Author

vinckr commented Jan 11, 2022 •
edited
Loading

First push was very low quality, should have been a draft PR 🙈.

I addressed your feedback, thanks for the pointers.

I am at a point now where I feel it is ready to be looked at again.

aeneasr
aeneasr reviewed Jan 11, 2022
View reviewed changes
UPGRADE.md Outdated Show resolved Hide resolved
aeneasr
aeneasr requested changes Jan 11, 2022
View reviewed changes
docs/docs/guides/upgrade.md Outdated Show resolved Hide resolved
docs/docs/guides/upgrade.md Outdated Show resolved Hide resolved
docs/docs/guides/upgrade.md Outdated Show resolved Hide resolved
@vinckr
Copy link
Member Author

vinckr commented Jan 12, 2022

Deleted UPGRADE.md and addressed the other feedback 👍

aeneasr
aeneasr approved these changes Jan 14, 2022
View reviewed changes
Copy link
Member

@aeneasr aeneasr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job @vinckr ! The plan is 👍

@aeneasr
Copy link
Member

aeneasr commented Jan 14, 2022

@vinckr could you do this for the other projects as well?

@aeneasr aeneasr merged commit 4a4ab05 into ory:master Jan 14, 2022
@vinckr
Copy link
Member Author

vinckr commented Jan 14, 2022

@vinckr could you do this for the other projects as well?

On the list 👍

@vinckr vinckr deleted the upgrade-guide branch January 14, 2022 16:51
This was referenced Mar 9, 2022
Merged
Merged
@vinckr vinckr mentioned this pull request Mar 18, 2022
Merged
@vinckr vinckr mentioned this pull request Apr 22, 2022
Merged
7 tasks
peturgeorgievv pushed a commit to senteca/kratos-fork that referenced this pull request Jun 30, 2023
@vinckr
docs: upgrade guide (ory#2132)
2c1fb41 
Closes ory#2104
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aeneasr aeneasr aeneasr approved these changes

@zepatrik zepatrik Awaiting requested review from zepatrik zepatrik is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@vinckr @aeneasr